Kotlin Computational Geometry/io.github.cponfick.kompgeom.euclidean.threed/Vec3

Vec3

data class Vec3(val x: Double, val y: Double, val z: Double) : Vector3<Vec3> (source)

An immutable 3-dimensional vector with double-precision components.

Constructors

Vec3

constructor(x: Double, y: Double, z: Double)

Types

Companion

object Companion

Properties

open override val x: Double

The x-component of the vector.

open override val y: Double

The y-component of the vector.

open override val z: Double

The z-component of the vector.

Functions

angle

open override fun angle(other: Vec3, angleUnit: AngleUnit = AngleUnit.RADIANS): Double

Calculate the angle between this vector and another vector.

computeScaleFactor

open fun computeScaleFactor(other: Vector3<*>): Double

Calculates the scale factor to project this vector onto another vector.

cross

open infix fun cross(other: Vector3<*>): Vec3

Calculates the cross product of this vector with another vector.

dimensions

open override fun dimensions(): Int

Returns the number of dimensions of the spatial object.

distance

open infix override fun distance(other: Vec3): Double

Compute the distance to another point.

dot

open infix override fun dot(other: Vec3): Double

Calculate the dot product of this vector with another vector.

open fun eq(other: Vector3<*>, equivalence: DoubleEquivalence = DEFAULT_DOUBLE_EQUIVALENCE): Boolean

Checks if two vectors are equal within a specified tolerance.

isFinite

open override fun isFinite(): Boolean

Returns true if all values in the spatial are finite.

isInfinite

open override fun isInfinite(): Boolean

Returns true if any value in the spatial is infinite.

isNaN

open override fun isNaN(): Boolean

Returns true if any value in the spatial is NaN (Not a Number).

lerp

open fun lerp(other: Vector3<*>, t: Double): Vec3

Performs linear interpolation between this vector and another vector.

minus

open operator override fun minus(other: Vec3): Vec3

Subtracts another vector from this vector.

norm

open override fun norm(): Double

Calculates the norm (magnitude) of the vector.

normalize

open override fun normalize(): Vec3

Normalizes the vector.

plus

open operator override fun plus(other: Vec3): Vec3

Adds another vector to this vector.

project

open fun project(base: Vector3<*>): Vec3

Calculate the projection of this vector onto another vector.

reject

open fun reject(base: Vector3<*>): Vec3

Calculates the rejection of this vector from another vector.

times

open operator override fun times(scalar: Double): Vec3

Scale this vector by a scalar value.

toImmutable

fun Vector3<*>.toImmutable(): Vec3

Returns this vector as an immutable Vec3.

toMutable

fun Vector3<*>.toMutable(): MutableVec3

Returns a mutable copy of this vector as a MutableVec3.

unaryMinus

open operator override fun unaryMinus(): Vec3

Negates the vector, flipping its direction.

withComponents

open override fun withComponents(x: Double, y: Double, z: Double): Vec3

Creates a vector with the specified components.

zero

open override fun zero(): Vec3

Get Zero vector.